Get list of mdmPolicy

GET

/v1/organizations/:organizationId/mdm/policies/

Request

Add parameter in header authorization

Example: Authorization: Bearer <token>

organizationId string

required

Entity Id or Slug

Match pattern: ^(([a-fA-F0-9]{24})|([a-zA-Z0-9\\-]{3,}))$

page integer

optional

Page number

limit integer

optional

Number of elements by page

sort string

optional

Match pattern: ^[\w.]*((:asc)|(:desc))?$

type string

optional

androidapplewindows

name string

optional

≤ 256 characters

policyId string

optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

search string

optional

≤ 256 characters

Responses

200 Response application/json

status boolean optional

data object optional

items array [object] optional

id string optional

Entity Id

Match pattern: ^[a-fA-F0-9]{24}$

type string optional

android apple windows

name string optional

≤ 256 characters

version integer optional

≥ 0

counts object optional

devices integer optional

≥ 0

applications integer optional

≥ 0

properties integer optional

≥ 0

targetType string optional

device deviceUser

updatedAt string optional

Format: date-time

createdAt string optional

Format: date-time

agentConfiguration object optional

allowLocation boolean optional

allowLocationMacos boolean optional

allowPackageTime boolean optional

allowPackageTransfer boolean optional

allowDeviceInfoBatteryUsage boolean optional

allowDeviceInfoBluetooth boolean optional

allowDeviceInfoSystemInfo boolean optional

totalDocs integer optional

{
    "status": true,
    "data": {
        "items": [
            {
                "id": "string",
                "type": "android",
                "name": "string",
                "version": 0,
                "counts": {
                    "devices": 0,
                    "applications": 0,
                    "properties": 0
                },
                "targetType": "device",
                "updatedAt": "2024-01-01T00: 00:00Z",
                "createdAt": "2024-01-01T00: 00:00Z",
                "agentConfiguration": {
                    "allowLocation": true,
                    "allowLocationMacos": true,
                    "allowPackageTime": true,
                    "allowPackageTransfer": true,
                    "allowDeviceInfoBatteryUsage": true,
                    "allowDeviceInfoBluetooth": true,
                    "allowDeviceInfoSystemInfo": true
                }
            }
        ],
        "totalDocs": 0
    }
}

401 Response application/json

status boolean optional

false

error object optional

code number optional

4004

message string optional

Invalid Token

{
    "status": false,
    "error": {
        "code": 4002,
        "message": "No auth token"
    }
}

404 Response application/json

status boolean optional

false

error object optional

code number optional

3001

message string optional

Entity not found

{
    "status": false,
    "error": {
        "code": 3001,
        "message": "Entity not found"
    }
}